/*
 * Quit.java
 *
 * Created on 29 octobre 2007, 18:37
 */
package com.reimscopie.console ;

import java.io.* ;


/**
 * This special command quits the shell.
 *
 * <p>The command the never invoked, because the shell catch the name to exit by itself.
 */
class Quit extends Command {
  
  /**
   * Creates a new <code>Quit</code> instance.
   */
  Quit() {
    
  }
  

  /**
   * Return the name of this command. The name is the first word in the shell
   * command line.
   *
   * @return <code>"quit"</code>.
   */
  public String getName() {
    return "quit" ;
  }
  
  
  /**
   * Return a short help message about this command.
   *
   * @return The command help.
   */
  public String getHelp() {
    return "Quit the shell" ;
  }
  
  
  /**
   * Return the command usage. This string must give all command options with
   * a description for each option.
   *
   * @return The command usage.
   */
  public String getUsage() {
    return "quit" ;
  }
  
  
  /**
   * Execute this command.
   *
   * @param args The arguments given in the command line.
   * @param output The command output.
   */
  public void execute(String[] args,ConsoleOutput output) {

    output.printError("ERROR : special command, should not be invoked",true) ;
    
  }
  
}
